About the Compatibility Wizard

 The Compatibility Wizard adds Windows 95 functionality to Windows 3.x Help systems, including Contents, Index, and Find tabs.

Introduction

Key features of WinHelp Compatibility Wizard

System requirements

Comparing WinHelp Compatibility Wizard and WinHelp HyperViewer

Using WinHelp Compatibility Wizard

Starting WinHelp Compatibility Wizard

Using WinHelp Compatibility Wizard

Creating a CNT file

Testing the Help project

Adding WinHelp Compatibility Wizard functionality to the Contents button

Changing the button text

Removing WinHelp Compatibility Wizard

Shipping a Compatibility Wizard Enhanced Project

Shipping your Help system

Reference

HPJ file additions

Elements in a CNT file

Contacting eHelp Corporation

Technical Support

eHelp Corporation headquarters

Sales


Key Features
Key features of WinHelp Compatibility Wizard

WinHelp Compatibility Wizard allows you to create Windows 3.x Help systems that have the popular Contents, Index and Find tabs of Windows 95/Windows NT Help systems. This allows you to provide your users with:

•	A graphical book and page Table of Contents for your Help system, called a Contents tab.  Click here to see a sample Contents tab.

•	The ability to print multiple topics at once using the Contents tab.

•	A WinHelp 4 style index, found on the Index tab. Click here see a sample Index tab.

•	Full-text search capabilities, courtesy of the Find+ tab. Click here to see a sample Find+ tab.

WinHelp Compatibility Wizard is easy to use. Simply run the Compatibility Wizard and select a Windows 3.x HLP file. You'll immediately have an index and find tab. By creating a CNT file, you can also easily add the Contents tab.

•	WinHelp Compatibility Wizard automatically registers all the necessary commands in the Windows 3.x Help file.

•	WinHelp Compatibility Wizard adds a Help Topics button to the button bar in a compiled Help system. This button takes users to the new Contents, Index, and Find+ tabs.

•	You do not need the source to a Help file to add this new functionality! You can work off of the Help (HLP) file!

See Also

Overview of the WinHelp Contents tab

Overview of the WinHelp Index tab

Overview of the WinHelp Find+ tab


Software requirements

WinHelp Compatibility Wizard is a 16-bit application that works with Windows 3.x Help projects. In order to run the WinHelp Compatibility Wizard, you need to have the following software installed on your system:

•	Windows Operating System. The development system can be Windows 3.x, 95, 98, NT 4.0, or 2000.

•	Approximately 1.5 MB of hard disk space for the WinHelp Compatibility Wizard files.


Overview of the WinHelp Contents tab

The Contents tab reveals an easy-to-read, structured view of a Help system (using books and pages). It allows users to explore a Help system visually and access a desired topic instantly.

•	The Contents tab allows users to print all topics in a book at once, rather than having to select and print each topic separately.

•	The Contents tab is fully configurable. You decide which books and pages (topics) to include and in what order by designing the contents file using RoboHELP.

•	The Contents tab is based on the Contents (CNT) file which is stored in the same directory as the Help file. If you make a change in the CNT file and send it to your users, the Contents tab updates itself automatically—you do not need to recompile the Help system for changes to take effect.

•	If you are already creating a CNT file for a WinHelp 4 Help system, the Compatibility Wizard allows you to have the same functionality in your Windows 3.x Help system!

The Contents tab appears only if a CNT file is associated with the Help file. If there is no CNT file, only the Index and Find+ tabs appear.


Overview of the WinHelp Index tab

•	The Index tab works like a traditional book index for a Help system. It lists keywords (words or phrases) alphabetically.

•	The Index tab replaces the functionality provided by the Search button of Windows 3.1 Help files.

•	The Index tab is particularly useful when a user needs to search for Help on a specific topic.


Overview of the WinHelp Find+ tab

•	The Find+ tab allows your users access to a full-text search of the Help system. This search is conducted by the WinHelp full-text search engine, which is superior to the standard WinHelp search engine.

•	WinHelp Find+ locates every occurrence of a selected word or text string within the Help file.

•	The Find+ tab displays the topics in which the search text appears. It also displays the number of occurrences the text appears in each topic. The list is sorted so that the topics with the most occurrences appear first.

•	Users can control the way in which the Find+ tab works by specifying search criteria such as Match case, Whole word only, and Look in topic titles only.

•	When your user displays a topic from the Find+ tab, the matching word or text string is highlighted automatically, allowing users to find information quickly.

•	From the Find+ tab, users can jump directly to a selected topic or print a particular topic.

•	WinHelp Find+ is fast—it scans an average size Help file in one second (speed is approximately .5MB/second).


Comparing the Compatibility Wizard and the HyperViewer
Comparing WinHelp Compatibility Wizard and WinHelp HyperViewer

RoboHELP Office contains two tools that let you add a book/page Table of Contents, multi-topic printing and full-text search to Windows 3.x Help systems: WinHelp Compatibility Wizard and WinHelp Hyperviewer. Each tool has its own strengths. This list will help you select the tool that is best for your needs.

Compatibility Wizard

•	Provides a closer WinHelp 4 look to your WinHelp 3 Help systems.

•	Adds a  [image]  to the main button bar. This accesses the Contents, Index, and Find+ tabs.

•	The Contents tab (Table of Contents) is fully configurable. You create the CNT file (that configures the Contents tab); so you design the layout of the Contents tab and decide which topics it contains.

•	The Contents tab closes when a user selects a topic. This is standard WinHelp 4 functionality.

Summary: With WinHelp Compatibility Wizard, your Help file looks just like a WinHelp 4 Help file and the Contents is fully configurable, however you will need to spend a little time designing a CNT file.

WinHelp HyperViewer

•	Adds HyperView and Find+ buttons to the main button bar.

•	Provides a HyperView Contents. This is an expandable, collapsible Contents using books and pages, however it functions differently. The HyperView Contents stays up when a user selects a topic.

•	The product is automatic. The HyperView is created automatically in seconds based on your Help project. There is no design work for you to do as far as creating a CNT file. You'll be done after you run the Wizard. All Help topics and hypertext links are included in the Hyperview.

Summary. With WinHelp Hyperviewer, you can add the functionality in seconds and the Contents stays on the screen for navigation, however, the Table of Contents is not configurable. It is created for you automatically based on your Help project.


Contents tab example


Index tab example


Find+ tab example


Starting WinHelp Compatibility Wizard

You can start WinHelp Compatibility Wizard from within RoboHELP or you can start it stand-alone from RoboHELP Office. WinHelp Compatibility Wizard registers the macros needed to provide enhanced functionality to Windows 3.x Help systems. When you run the Compatibility Wizard, all of the statements needed for this support are added to your Help project (HPJ) or your Help (HLP) file.

To start WinHelp Compatibility Wizard from RoboHELP:

1	In the RoboHELP Explorer, click the Tools tab.

2	Double click the WinHelp Compatibility Wizard icon [image]. WinHelp Compatibility Wizard appears.

To start WinHelp Compatibility Wizard from RoboHELP Office on a Windows 95, 98, NT 4.0, or 2000 system:

1	From the Start menu, click Programs, choose RoboHELP Office, then RoboHELP Office. The RoboHELP Office Starter appears.

2	Click the Tools tab.

3	Double click the WinHelp Compatibility Wizard icon [image]. WinHelp Compatibility Wizard appears.

To start WinHelp Compatibility Wizard from RoboHELP Office on a Windows 3.1 system:

1	Open the RoboHELP Office program group.

2	Double click the WinHelp Compatibility Wizard icon [image]. WinHelp Compatibility Wizard appears.

See Also

Using WinHelp Compatibility Wizard


Using the WinHelp Compatibility Wizard
Using WinHelp Compatibility Wizard

You can run WinHelp Compatibility Wizard on the HPJ file or the HLP file. If you run it on the HLP file, if you later recompile the Help file you will lose the added functionality. If you run the Compatibility Wizard on the HPJ file, you can recompile the Help file without losing the WinHelp 4 functionality.

1	Start WinHelp Compatibility Wizard.

2	Click Browse to select a Help (HPJ) project or a Help (HLP) file.

3	Click Next.

4	Choose whether to add a Help Topics button. Leave the checkbox enabled to add the Help Topics button functionality.

5	Edit the text for the Help Topics button. The default is Help Topics because this is a WinHelp 4 convention.

6	Enter the title of the button in the Button title field. Use the ampersand (&) to indicate that the next character is the hot key for the button.

7	Click Finish then click OK. The Compatibility Wizard automatically runs the Help file if you have modified a Help (HLP) file. If you have modified a Help project (HPJ) file, it must be recompiled.

If you do not see a Help topics button when you run the compiled Help system, it may be because you are developing on a Windows 95, 98, NT 4.0, or 2000 system. The Help Topics button only shows up on a Windows 3.x system. If you are running Windows 95, 98, NT 4.0, or 2000, click the Contents button (if there is a CNT file) or the Search button to see the new functionality.

The Help system must have an associated CNT file for a Contents tab to display. If the Help system does not have a CNT file, only the Index and Find+ tabs display. See Creating a CNT File for more information.

See Also

Testing the Help Project

Changing the Help Topics button text

HPJ file additions the Compatibility Wizard performs

Shipping your Help system


Creating a CNT file

If you want to take full advantage of the WinHelp Compatibility Wizard's ability to add WinHelp 4 functionality to Windows 3.x Help files, you should create and ship a Contents (CNT) file with your Help file. The CNT file provides the information for the Contents tab, an integral part of WinHelp 4 Help conventions. If you do not include a CNT file with your Help file, the Compatibility Wizard only adds the Index and Find+ tabs under the Help Topics button.

Creating a Contents file is easy! You can create it visually using RoboHELP's TOC composer, part of the RoboHELP Explorer. Simply add books and pages to the composer, move or arrange then as desired, then RoboHELP generates the CNT file for you. For more information, see the RoboHELP Help system.

See Also

Elements in a CNT file


Changing the Button Text
Changing the Help Topics button text

The easiest way to change the button text for the Help Topics button is to do so from the Help (HLP) file. Since you must have the HLP file (you can always compile the Help project to create it), the following directions are given from this perspective. If you have not compiled the Help project yet and therefore do not have the Help (HLP) file, do so before beginning these directions.

To change the button text for the Help Topics button:

1	Start the WinHelp Compatibility Wizard.

2	Click Browse to select the appropriate Help (HLP) file; then click OK.

3	Click Next.

4	Enter the desired button text in Button title, and confirm that the Yes checkbox is enabled.

5	Click Finish. The status bar advances as the WinHelp Compatibility Wizard functions.

6	Click OK.


Adding the Compatibility Wizard functionality to the Contents button

The Compatibility Wizard automatically adds a Help Topics button to the main button bar of an enhanced Help project. However, you can add this same functionality to the Contents button, with a simple macro.

You must first run the Compatibility Wizard on the Help project, before beginning the following steps!

To add the Compatibility Wizard to the Contents button instead of the Help Topics button:

1	Open the Compatibility Wizard-enhanced Help project in RoboHELP.

2	From the RoboHELP Explorer Project tab, open the Project folder.

3	Open the Startup Macros folder.

4	Select the following macro: HyperTopicsCreateButton3x["IDH_HYPERTOPICS","Hel&p Topics","HyperTopicsDMShowWindow()"].

5	Press Delete to delete this macro.

6	Right click the Startup Macros folder and choose New Startup Macro.

7	Click the Macro button.

8	Under Choose a Macro to Insert, click the down arrow to select the macro: ChangeButtonBinding[button-ID,button-macro]

9	Click Insert.
RoboHELP inserts the macro.

10	Edit the macro command script so that it reads: ChangeButtonBinding["BTN_CONTENTS","HyperTopicsDMShow
Window()"]

11	Click OK through two dialog boxes to accept your changes.


Removing the Compatibility Wizard
Removing WinHelp Compatibility Wizard functionality

WinHelp Compatibility Wizard registers DLLs in your Help project to enhance the functionality. If you decide not to use the functionality, you may want to remove them.

If you originally ran the Compatibility Wizard on the HLP file, you can simply recompile the Help file to remove the added functionality.

To remove the compatibility wizard functionality, you simply run the Compatibility Wizard again:

1	Double click the WinHelp Compatibility Wizard icon [image] in either the RoboHELP Office Starter or the RoboHELP Explorer Tools tab. WinHelp Compatibility Wizard appears.

2	Click Browse to select the Help (HPJ) project or a Help (HLP) file.

3	Click Next.

4	De-select the Help Topics button checkbox. If the checkbox is not enabled, the functionality is removed.

5	Click Finish then click OK. The functionality is removed.


Testing the Help project

If you are performing your Help authoring on a Windows 95, 98, NT 4.0, or 2000 platform, there are some things you should keep in mind for testing the Windows 3.1 Help project you are creating.

•	You will not see the Help topics button on a Windows 95 platform. This is because by default, Windows 95 looks for a CNT file and connects the functionality to  the Contents button and Search button. If you do not see the button, try running the HLP file on a Windows 3.1 system. The button should now appear.

•	The Compatibility Wizard is designed to add functionality to Windows 3.1 Help systems. You need to test your Help project on a Windows 3.1 Help system. When you do, be sure to install all the required files.


Shipping your Help system

The enhanced WinHelp 4 functionality created by the Compatibility Wizard is implemented by DLLs, called by the Help system when the user selects the Help Topics button. In order for the commands to operate properly on an end user's system, you must include the DLLs when you distribute your Help system.

Necessary Files to Ship

•	The Help (HLP) file.

•	The associated Contents (CNT) file, if you want the Contents tab to display.

•	The following DLLs:

Filename	Where to Install	Functionality
CTL3DV2.DLL	Windows\system Directory	Provides 3D "look and feel" and gray dialog boxes.
CNT31.DLL	Windows\system Directory	Provides Contents, Index and Find+ Tabs.
HYPERTOP.DLL	Windows\system Directory	Provides Contents, Index and Find+ Tabs.
You will find these files on your hard disk. The DLLs are installed by default into your Windows\system directory.

Installation of the Help system and the DLLs is typically handled by the installation program for the product that your Help system documents. You may wish to notify the appropriate person that the files listed above need to be included in the installation.

You may also want to provide information on how to use the enhanced WinHelp 4 functionality in your printed documentation or online Help. In keeping with this need, we have provided informative material (CMPATWIZ.DOC) that you may include in your printed documentation. This Microsoft Word file is located in the directory: WINHELP\CMPATWIZ\DOCS. You may use this file and distribute it royalty-free.

See Also

How to ship if your user will run the Help file from CD-ROM


Running a Help file from CD-ROM

It is possible to place the HYPRTOP.DLL and the CNT31.DLL in the same directory in which your Help file is located. This location may be useful if you want to have users run the Help file from a CD-ROM and do not wish to install the Help file or DLLs on the users hard disk.

If you choose to do this, you can create an icon in Program Manager that points to the Help (HLP) file on the CD-ROM. Users can simply click on the icon to run the Help file.

Additionally, you can instruct users to run the Help system by clicking on the Help file from File Manager.

CTL3DV2.DLL should not be placed in the same directory as the Help file—it must be in the users Windows\system directory. CTL3DV2.DLL is already installed on most Windows systems, but you should check for it, and if it is not there, install it into the Windows\system directory.


HPJ file additions

The following are macros which control the action of the Compatibility Wizard. WinHelp Compatibility Wizard registers these in the [CONFIG] section of your Help Project (HPJ) file.

The following lines are added to your HPJ file by the WinHelp Compatibility Wizard:

RegisterRoutine ("cnt31.dll","ContentsDMInit","") ;=

RegisterRoutine("hypertop.dll","HyperTopicsDMInit","") ;=

RegisterRoutine("hypertop.dll","HyperTopicsDMShowWindow","") ;=

RegisterRoutine("hypertop.dll","HyperTopicsDMHideWindow","") ;=

RegisterRoutine("hypertop.dll","HyperTopicsDMMoveWindow","") ;=

RegisterRoutine("hypertop.dll","HyperTopicsDMMoveWindow","iiiii") ;=

RegisterRoutine("hypertop.dll","HyperTopicsDMOnTop","i") ;=

Register Routine("Hypertop.dll","HyperTopicsCreateButton3x","SSS") ;=

ContentsDMInit() ;=

HyperTopicsDMInit() ;=

HyperTopicsCreateButton3x("Hel&p Topics","") ;=


Elements in a CNT file

If you open a CNT file in an editor such as Notepad, you'll see some or all of the following elements. Note that RoboHELP generates the CNT file for you automatically, so you do not need to learn these. This information is provided for your reference.

Element	Type	Description
Numbers	Required	Levels in the Contents tab that define Books and Topic Pages. Numbers are followed by text that displays in the Contents tab.  Page  If the item is a jump to a Help topic, the text is followed by the equal (=) sign and the Topic ID (context-string) of the topic to be displayed.  Book If the text is not followed by the equal sign, WinHelp assumes this is a Book that has additional levels below it.
:Title	Optional	Statement that defines the text that appears in the title bar of the Contents window when the Help file appears.
:Base	Required	Statement that defines the name of the compiled Help (.HLP) file. This statement can also include the name of the default window used to display the Help system. If a window name is included, you must precede it with the greater than (>) character.
		Note: The window name is optional—if a window name is not specified, WinHelp 4 Help uses its standard window.
:Index	Optional	Statement that defines the Help files to be included in the search keyword list in the Index tab. This statement must not include any text except: :Index=Filename.hlp. To include multiple files in the Index, you must include multiple :Index statements.
:Include	Optional	Statement that defines the CNT files to be included in the current CNT file. This allows you to provide books and pages which jump to other Help files. If WinHelp cannot find the CNT file referenced by the Include, the statement is ignored.


Troubleshooting

Here are some messages you may encounter and suggestions for solving the problem.

When I try to run my project, I see the message: "A new version of WinHelp Compatibility Wizard is needed for this Help compiler".

This occurs if you are working in WinHelp 4 mode (or WinHelp 4 mode with WinHelp 3 compatibility) within RoboHELP. WinHelp Compatibility Wizard is designed for WinHelp 3 Help systems (help systems for Windows 3.1 systems).

•	If you are getting the above message and intended to create a WinHelp 3 Help system, from the RoboHELP Explorer File menu, choose Set Primary Target. Change the primary target to WinHelp 3.

•	If you are getting the above message because you ran WinHelp Compatibility Wizard on a WinHelp 4 project and realized you don't need the Compatibility Wizard functionality, you can remove it. See Removing WinHelp Compatibility Wizard.

When I run the Help file, I see a message: "Routine not found".

One of the required DLLs is not located in the proper folder on the system where the message is appearing. See Shipping your Help system for more information.


eHelp Corporation headquarters

eHelp Corporation is the worldwide leader in Help authoring solutions. Software developers, Help authors, technical writers, and documentation experts worldwide turn to eHelp Corporation for state-of-the-art Help authoring and Internet/intranet solutions.

Corporate Headquarters

Address:	eHelp Corporation 7777 Fay Avenue, Suite 201 La Jolla, CA 92037 U.S.A.
Telephone:	1-858-551-2485
Fax:	1-858-551-2486
World Wide Web:	www.blue-sky.com
Office Hours:	Monday to Friday 6:00 A.M. to 5:00 P.M. Pacific Time

eHelp Corporation Sales Department

eHelp Corporation Technical Support Department


Sales

eHelp Corporation's professional sales staff is ready to answer your sales questions Monday to Friday from 6:00 A.M. to 5:00 P.M. Pacific Time.

Contact your sales representative to hear about the latest products, the Subscription Plan, training, upgrade options and prices, and more. If you have a technical question or problem, please contact Technical Support.

Contacting your eHelp Corporation Sales Representative

Sales Phone:	1-800-677-4946
International (including Canada):	1-858-459-6365
Sales Fax:	1-858-459-6366
World Wide Web:	www.blue-sky.com
Sales Email:	sales@blue-sky.com
When sending email, please include your company name, city, and state to ensure your request is handled promptly.


Technical Support

At eHelp Corporation, we work hard to provide you with intuitive technical products. Additionally, we try to provide superior online and print documentation to enable you to work independently. If you have a technical question that you can't answer with the provided tools, please contact our Technical Support department. All of our Technical Support representatives are eager to answer your questions and help you create the best Help systems possible.

Note: You must be a registered user to access eHelp Corporation support services. eHelp Corporation support services are subject to the prices, terms, and conditions in place at the time the service is used.

eHelp Corporation's Technical Support services includes email, telephone, and Web-based support on our corporate Web site (www.blue-sky.com).

Help Us Help You

When contacting Technical Support via phone or email, please provide the following information for the fastest possible service:

•	Product serial number (registration number)

•	Your name, company name, and phone number

•	Exact product name and version number

•	Type of operating system (e.g., Windows 95)

•	Version of Microsoft Word (if using RoboHELP for WinHelp)

•	Browser and version (if creating HTML-based Help)

•	Complete description of the issue, including steps to reproduce it

•	Exact wording of any messages displayed when you encountered the problem

•	Steps taken to resolve the problem

•	All previous email threads with eHelp Corporation about the issue, if any

For current hours of operation and details about all support offerings, please:

•	Visit our Web site (www.blue-sky.com)

•	Email us at supportnews@blue-sky.com to receive an automated reply listing all of your support options.

•	Call us at 858-551-2194.


Premium Support

Premium Support entitles plan members to priority Technical Support access through a dedicated telephone line and a dedicated email address. Plan members receive direct access to eHelp Corporation's seasoned Senior Technical Support Engineers.

Premium Support plans are available for current and previous versions of eHelp Corporation products.